home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / FROMUTS / GRAPHDRAW / !GraphDraw / !Help < prev    next >
Text File  |  1990-11-19  |  14KB  |  375 lines
  1. !GraphDraw, © Chris Johnson, 1990
  2.  
  3. These user notes refer to version 0.9 (July 1990) only.
  4.  
  5.  
  6. *********************************************************
  7.  
  8. ACKNOWLEDGEMENT
  9.  
  10. THIS PROGRAM WAS COMPILED USING THE DABS PRESS ARCHIMEDES
  11. BASIC COMPILER (ABC)
  12.  
  13. *********************************************************
  14.  
  15.  
  16. What this software does
  17. =======================
  18.  
  19. It allows the entry of the x and y values for a number of
  20. data, and the data may then be fit to
  21.  
  22. a. best straight line
  23. b. best parabola
  24. c. a cubic spline curve
  25. d. a polynomial of order up to 6
  26.  
  27. A number of options for obtaining various forms of hard copy
  28. exist (saving as a sprite file, saving as a !Draw file, or
  29. printing via any standard RISC-OS printer driver).
  30.  
  31. Use of !GraphDraw
  32. =================
  33.  
  34. Running the application
  35. -----------------------
  36.  
  37. This software is fully RISC-OS compatible, and is
  38. multi-tasking. It can be run from the desktop in all the
  39. standard ways.
  40.  
  41. NB. The display of the graph uses outline fonts to annotate
  42. the axes etc.. It is therefore necessary for the operating
  43. system to have "seen" the !fonts directory before the
  44. program is run. Otherwise an error message may be generated.
  45. The default font used is Trinity.Medium, since this comes on
  46. the RISC-OS applications disc, and both old and new version
  47. font managers can deal with it (the new outline font manager
  48. will work with the old bitmapped fonts).
  49.  
  50. Double clicking on the !GraphDraw icon in a directory viewer
  51. will install its icon on the icon bar. Clicking 'menu' on
  52. this icon will lead to a menu providing 
  53.  
  54. 1. a standard information window with version number
  55. 2. the opportunity to quit the application.
  56.  
  57. Clicking 'select' will open an empty edit window, into which
  58. the pairs of x,y data may be entered. This version allows a
  59. maximum of 40 data point pairs. Full scrolling and editing
  60. facilities are available during data entry. Remember to
  61. press <RETURN> when editing the contents of a particular
  62. slot to enact the change.
  63.  
  64. The application can also be started by double clicking on a
  65. data file of the correct format. In this case, besides the
  66. icon appearing on the icon bar, the edit window will be
  67. opened with the contents of the data file displayed, for
  68. further editing if necessary. A data file may also be
  69. dragged, either into the edit window, or to the iconbar
  70. icon. The data will be loaded, overwriting any data that had
  71. previously been entered.
  72.  
  73. Data can also be passed in either direction between the
  74. GraphDraw edit window and a !edit window. Thus editing can
  75. be carried out using the !edit application if preferred.
  76. Data can be entered 'from scratch' using !edit, and then
  77. transferred to the !GraphDraw application (by dragging a
  78. save icon to its edit window or its iconbar icon), as long
  79. as the !GraphDraw application can recognise a valid data
  80. file. This version of !GraphDraw takes the easy way out and
  81. uses the <wimp$scrap> file passing protocol with a temporary
  82. disc file. Users of single floppy disc machines may be
  83. prompted for the disc on which the <wimp$scrap> file is to
  84. be saved (by default in the !system directory). [HINT: It is
  85. possible to redirect the <wimp$scrap> file to the RAM disc,
  86. for example. This will prevent disc swapping, and is very
  87. fast. It requires that a RAM disc is always configured.] It
  88. is intended that the next version will use direct memory
  89. transfer for these operations. As the graphdraw application
  90. will deal with files of comma separated ASCII data it is
  91. possible to set up other applications to produce data files
  92. of the correct form.
  93.  
  94.  
  95. The !GraphDraw edit window menu
  96. ===============================
  97.  
  98. All of the data processing and data display facilities are
  99. accessed from the edit window menu.
  100.  
  101. Clicking the 'menu' button in the edit window brings up the
  102. following choices.
  103.  
  104. Info
  105. ----
  106. The standard information window.
  107.  
  108. Clear data
  109. ----------
  110. This will irretrievably clear the current data prior to the
  111. entry of new data.
  112.  
  113. Save file
  114. ---------
  115. Data files may be saved by dragging the save icon to a
  116. directory viewer. If the full path name is set up, then you
  117. can also click on the OK icon to save the data.
  118.  
  119. It is also possible to drag the save icon to a !Edit window,
  120. or to the !Edit icon on the iconbar. The data is then
  121. transferred into !Edit.
  122.  
  123. Plot points
  124. -----------
  125. This will simply plot a scaled graph of the data.
  126.  
  127. Best line
  128. ---------
  129. This will carry out a standard linear regression by the
  130. least squares method to calculate the best fit straight line
  131. through the data. A window will open displaying the slope,
  132. intercept on y axis, correlation coefficient and the
  133. standard errors of the slope and intercept. Clicking 'menu'
  134. in this window allows the following choices.
  135.  
  136.    Graph
  137.    -----
  138.    This will display a graph of the data points with the
  139.    calculated best line superimposed. Clicking 'menu' in the
  140.    graph window leads to a further set of options (see below
  141.    under cubic spline).
  142.  
  143.    Print data
  144.    ----------
  145.    This will send the results of the calculation to any
  146.    printer connected to the computer. The individual errors
  147.    calculated for each data point are also printed.
  148.  
  149. Parabola
  150. --------
  151. This will carry out a least squares fit of the data to the
  152. equation of a parabola
  153.  
  154.       y = u + vX + wX^2.
  155.  
  156. This is a useful technique for fitting data to a simple
  157. curve. A window will open showing the calculated values of
  158. the coefficients u, v and w. Clicking 'menu' in this window
  159. will bring up the same two options as described above, i.e.
  160. graph and Print data.
  161.  
  162. Polynomial
  163. ----------
  164. This will carry out a standard polynomial fit for orders 3
  165. to 6. Some of the higher order options may be greyed out if
  166. there are not enough data points. Selecting a particular
  167. order will force the program to calculate that specific
  168. order polynomial, whereas if 'All' is selected, the program
  169. will try all possible orders (3 to 6) and report the one
  170. which gives the smallest deviation. A window will open
  171. showing the results of the calculation, and clicking 'menu'
  172. on this window leads to the same options as above.
  173.  
  174. Cubic spline
  175. ------------
  176. This will display a graph of a smooth cubic spline through
  177. all the data points. It is based upon an algorithm in
  178. "Numerical Methods" by Press et al. For this plot, it
  179. requires all the data to be sorted in order. The program
  180. automatically sorts the data in ascending order of x values
  181. before carrying out the spline routine. This version plots a
  182. natural spline curve through all the data points.
  183.  
  184. The next version will allow the 'degree of smoothness' to be
  185. specified, so that experimental scatter in the data set may
  186. be allowed for.
  187.  
  188. Graph window menus
  189. ==================
  190.  
  191. Whenever a graph is being displayed, clicking 'menu' will
  192. lead to a further range of options. Some of these are common
  193. to all the graph types, others are specific to cubic spline.
  194. Rather than repeat the same thing several times over, all
  195. the common options are dealt with here.
  196.  
  197. The common options
  198. ------------------
  199.  
  200. Screensave
  201. ----------
  202. This saves the whole graph screen as a sprite, which can
  203. then be loaded into !Paint, or !Draw for example. The screen
  204. can be printed from either of these utilities using the
  205. RISC-OS printer drivers. There is no choice in filename - it
  206. saves in the current directory using grafwinN, where N is a
  207. decimal number which increments with each save. It defaults
  208. to 1 each time the program is run, thus any existing files
  209. from a previous session will be overwritten if there are any
  210. in the current directory
  211.  
  212. Legend
  213. ------
  214. This opens a window which allows you to enter text to label
  215. the graph axes, and a title string for the graph. Clicking
  216. on display will place the labels on the graph, while delete
  217. will remove labels from the graph (the text remains in
  218. memory and can be reinstated by reselecting label and
  219. clicking on display). Simply closing the menu will leave the
  220. state of the labels as they were.
  221.  
  222. The labels are dragable icons and can thus be dragged to
  223. anywhere on the graph if you dont like the default
  224. positions. The same labels will appear on any graph, with
  225. the previous position being remembered. The y-axis label is
  226. plotted vertically, reading downwards. This is something I
  227. am not too sure about as far as the aesthetics of display
  228. are concerned. I have not yet worked out how to rotate
  229. outline font text through 90 degrees so that it reads up the
  230. axis! [HINT: If you have FontFX, then you can use this to
  231. convert the outline font to draw files that can be rotated.
  232. Save the graph as a draw file, and then import the y-axis
  233. legend from FontFX.]
  234.  
  235. If data is saved after legends have been entered, then the
  236. text is also saved, and is reloaded when the data is
  237. reloaded.
  238.  
  239. Layout
  240. ------
  241. This leads to a dialogue window in which various aspects of
  242. the way the graph is laid out may be changed, e.g. whether
  243. the axis pips are inside, outside or straddle the axis
  244. lines, the size of the pips, whether the graph is boxed in,
  245. and the type of symbol used for the data points. These
  246. aspects are under continuous development, and will be
  247. enhanced in future releases. (Note that the size of the pips
  248. is related to the size of the divisions on the other axis)
  249.  
  250. Make Drawfile
  251. -------------
  252. A standard 'save as' dialogue box will be opened. The file
  253. icon may be dragged to a directory viewer, or if the full
  254. filename path is set up it is possible to click on OK. The
  255. file saved is a Drawfile of the graph being displayed. This
  256. file can then be loaded into !Draw for further enhancement.
  257. It is also permissible to drag the file icon into a !draw
  258. window to add the graph to an existing draw document, or
  259. drag the icon to the !draw icon on the iconbar, when a new
  260. draw window will be opened. These latter operations make use
  261. of the wimp$scrap protocol in the present version - direct
  262. memory to memory transfer is to come! The production of
  263. !Draw format files means that the graphs can be loaded into
  264. !Draw for enhancement, and can also be loaded into the
  265. various DTP packages now available (it certainly works for
  266. Acorn DTP and Beebug's Ovation packages).
  267.  
  268. When it is first loaded into !draw, the whole graph appears
  269. as one object, and may be scaled, moved, etc. as a whole.
  270. The line thickness may be changed, or even the font used may
  271. be altered. However, in the latter case, you may find that,
  272. if the font metrics are very different to Trinity, then the
  273. alignment and centring of text is incorrect. [I hope the
  274. next improvement to !graphdraw will allow the outline font
  275. to be changed from within !graphdraw.] The objects making up
  276. the graph may be ungrouped in the normal way. This allows
  277. adjustment of individual parts of the graph, or annotation.
  278. It needs care when dealing with the individual parts of the
  279. graph, otherwise you may inadvertantly move parts of the
  280. axis for example, or even the graph itself, and have great
  281. trouble getting it back to the correct place.
  282.  
  283. If you are familiar with using !draw, then it should be easy
  284. to play around with the draw files output by !graphdraw.
  285.  
  286. Print Graph
  287. -----------
  288. Choosing this option gives a printout of the complete graph
  289. via whichever printer driver application is installed. A
  290. printer driver must be installed, otherwise !Graphdraw will
  291. complain. This allows a much higher quality hard copy to be
  292. obtained compared to a simple screen dump, up to the best
  293. available resolution of the printer used.
  294.  
  295. Cubic Spline option only
  296. ------------------------
  297.  
  298. Interpolate
  299. -----------
  300. This option is available ONLY from the cubic spline graph,
  301. and allows the interpolation of single values, or the
  302. dumping of a range of values to the printer. Note that it is
  303. not possible to extrapolate the spline curve beyond either
  304. of the end points.
  305.  
  306.  
  307. *************************************************************
  308.  
  309.  
  310. The software referred to in these notes is NOT placed into
  311. the  public domain, but remains the copyright of the author,
  312. Chris Johnson. It is released for distribution by Norwich
  313. Computer Services under their Shareware/Careware scheme
  314. only, and should not be posted on bulletin boards or
  315. circulated on any public domain software discs, except by
  316. prior and express agreement with the author, or with Norwich
  317. Computer Services.
  318.  
  319. Anyone obtaining this software by any means other than
  320. direct purchase from Norwich Computer Services and making
  321. use of the software other than for trial purposes, is
  322. requested to register with the author by sending £3 (most
  323. of which will find its way to an approved charity), or to
  324. send a donation to charity directly to NCS. All users
  325. registering directly with the author will be informed from
  326. time to time of any significant improvements or 'bug' fixes
  327. and will be entitled to upgraded versions of the software
  328. free of charge by sending a blank disc.
  329.  
  330. The software is supplied as is, and no warranty, either
  331. express or implied, is given as to the suitability of the
  332. software for any purpose.
  333.  
  334. Notwithstanding the above, the author would, of course, be
  335. interested in hearing of any 'bugs' or any  other unexpected
  336. features, and will endeavour to correct any such 'bugs' so
  337. reported in any future issues of this software. Suggestions
  338. for improved features are also most welcome. Implementation
  339. of suggestions depends of course on practicability and more
  340. importantly, the authors spare time (I do have a full time
  341. job!).
  342.  
  343. If you have any comments on this program, or would like to
  344. suggest ways in which it could be improved then the author
  345. can be contacted directly.
  346.  
  347. Chris Johnson
  348. 7 Lovedale Grove
  349. Balerno
  350. Edinburgh
  351. EH14 7DR
  352.  
  353. If you wish to enter into the 'shareware' concept in the
  354. full  sense then registrations (>=£3) will be gratefully
  355. received by the  author.
  356.  
  357. If, in any communication, you make specific reference to the 
  358. program code, then please
  359.  
  360.       (a) quote the version number and date
  361.  
  362.       (b) refer only to the program as issued.
  363.  
  364.       (c) supply as many details as possible about the
  365.           problem, and indicate the hardware configuration of
  366.           the machine being used.
  367.  
  368. PLEASE SEND A STAMPED AND SELF ADDRESSED ENVELOPE IF YOU
  369. REQUIRE A REPLY.
  370.  
  371. I hope you find the program of some use.
  372.  
  373. CafJ 02/11/1990
  374.  
  375.